Config: Add the read_only setting
#65
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sphuber
force-pushed
the
feature/065/config-read-only
branch
from
c5a324e
to
c7aed7c
Compare
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## master #65 +/- ##
==========================================
+ Coverage 93.39% 93.44% +0.05%
==========================================
Files 28 29 +1
Lines 999 1022 +23
==========================================
+ Hits 933 955 +22
- Misses 66 67 +1
Flags with carried forward coverage won't be shown. Click here to find out more.
☔ View full report in Codecov by Sentry. |
|
@giovannipizzi @eimrek This would be a possible implementation to allow easily making an instance of the API fully read-only. |
|
Heya, how do other fastapi packages achieve this? Is there any documentation links? |
I tried googling, but nothing concrete showed up. Might be that I have missed it of course. |
This is the recommended way as per the documentation of `fastapi` as it can be easily made available to routes.
This setting, which is set to `True` by default, will determine whether the instance is to be read-only. The `protected_methods_middleware` function is added as middleware to the application. If the `read_only` setting is `True` and the request method is `DELETE`, `PATCH`, `POST` or `PUT`, a `405 Method Not Allowed` response is returned.
agoscinski
force-pushed
the
feature/065/config-read-only
branch
from
c7aed7c
to
a3535a3
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #63
This setting, which is set to
Trueby default, will determine whetherthe instance is to be read-only. The
protected_methods_middlewarefunction is added as middleware to the application. If the
read_onlysetting is
Trueand the request method isDELETE,PATCH,POSTorPUT, a405 Method Not Allowedresponse is returned.